home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
spitfire
/
doork10.zip
/
DOORKNOB.DOC
< prev
next >
Wrap
Text File
|
1992-04-26
|
10KB
|
236 lines
┌──────────────┐
│ DOORKNOB.EXE │
└──────────────┘
Door or Menu Extension Program
Tom Kellen
ßETATech Computer Consulting
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
PURPOSE: To provide additional options from a Spitfire BBS menu or
additional door options for many BBS's.
INTRODUCTION:
DoorKnob provides a way to add more selections to a Spitfire BBS
menu extension or to add to the number of doors a BBS can run. It
is quite simply, a front end to some batch files that run your
other doors or programs. DoorKnob provides the menued interface to
these programs and monitors logon time and carrier while it is
active.
INSTALLATION:
Create a directory for your menu extension files. For
documentation purposes we will assume that you are using
C:\SF\DKMAIN. Copy DOORKNOB.EXE and DOORKNOB.CFG into this
directory. You will also need to create DOORKNOB.CLR and
DOORKNOB.BBS which are your color and mono menus for DoorKnob (see
the examples enclosed with the program). You must also place the
batch files that you wish to be accessed from DoorKnob into this
directory. They should be named A.BAT - Z.BAT. You can run up to
25 programs from DoorKnob (Q.BAT is not used and if you enable
logoff via DoorKnob, then G.BAT will also NOT be used).
You will need to modify at least 2 lines in DOORKNOB.CFG (on each
line in the configuration file, any text after the ; are considered
comments and ignored). Here is an example configuration file:
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
BBS=The Paradigm BBS; Your BBS Name
REGNO=000000; Registration Number, leave as 000000 if unregistered
LOG=C:\LOGS\DOORKNOB.LOG; Log to this file instead of CALLERS.TMP
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
The first line is the name of your BBS. This will be displayed as
the door closes and will also be displayed on the main menu once
you register the door.
The second line is your registration number. If you are still
evaluating the door and have not registered, leave this as 000000.
The third line is an alternate log file. By default DoorKnob logs
to CALLERS.TMP for the node that called it so that all information
will be placed in CALLERS.LOG. If you wish logging for this door
to go elsewhere, add a line like above using the key word LOG=.
This line is optional and if omitted, all logging will go to your
caller's log.
If you don't want to have the beeps the door makes echoed on the
local side (ie. sweet silence mode) then place the key word NOBEEP
on a line in DOORKNOB.CFG.
By default the door allows users to log off. The door will write
this to the log file, but Spitfire may also place a line stating
"Improper return from door...". This just means that the door
dropped carrier. If you wish to disable the ability for users to
log off via the door, place the key word NOLOGOFF on a line in your
DOORKNOB.CFG file.
In an effort to give the maximum amount of memory possible to the
programs it runs, DoorKnob will swap most of it's code when it runs
a program. If EMS memory is available, DoorKnob will swap the code
to EMS. If there is not sufficient EMS available, DoorKnob will
swap it's code to disk. DoorKnob will look for the environment
variables "TEMP" and "TMP" as these usually point to RAM drives.
If either of these environment variables exist, DoorKnob's code
will be swapped to the directories specified. If these variables
don't exist, and there is insufficient EMS, DoorKnob will swap it's
code to the current directory. There are some cases where you
might not want to take advantage of this code swapping. If you do
not want to take advantage of DoorKnob's code swapping, add a line
to your DOORKNOB.CFG file that has the key word NOSWAP. This will
disable swapping when executing a program.
The lines in your DOORKNOB.CFG file can be in any order but they
must start with the key words BBS=, REGNO=, LOG=, NOBEEP, NOLOGOFF,
or NOSWAP. The first 2 are required, the rest are optional.
Once you have completed this, you will need to modify your menu
extension BAT to install DoorKnob.
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
@Echo Off
BRK OFF
CD\SF\DK
COPY C:\SF\SFMAIN.DAT
DOORKNOB /DEBUG /DAT=C:\SF /C=C:\SF\DK\DOORKNOB.CFG
ERASE C:\SF\DK\SFMAIN.DAT
CD\SF
BRK ON
-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
This snippet is also included in the distribution ZIP as
SFMAIN.BAT. Just remember to copy SFMAIN.DAT (or one of the other
SFxxxx.DAT, or DOOR.SYS) to DoorKnob's directory. DoorKnob needs
this information. If you are running multiple nodes of Spitfire
you can call DOORKNOB with a /DAT= on the command line indicating
the path to the SFDOORS.DAT file you wish to use. (ie. DOORKNOB
/DAT=C:\SF01) When you use /DAT= on the command line you do NOT
have to copy the .DAT file to the DoorKnob directory. This should
allow multiple nodes to access the same copy of DOORKNOB.EXE. It
is able to read all of the .DAT files (SFDOORS.DAT, SFMAIN.DAT,
SFMESS.DAT and SFFILE.DAT and DOOR.SYS). Just make sure you copy
the correct one or indicate the path to the file using /DAT=.
Multiple node systems may need to have different configuration
files for different nodes. If you need this ability, you can
specify a configuration file name on the command line using /C=.
This parameter requires that you enter the whole path and file name
after the /C= (ie. DOORKNOB /C=C:\SF\DKMAIN\NODE02.CFG). When you
use /C=, DoorKnob will use the directory specified to look for it's
menu and .BAT files. This should allow for one copy of
DOORKNOB.EXE to be used for several different extensions and on
multi-node BBS's.
OPERATION:
When a user runs DoorKnob, it reads the SFDOORS.DAT file to get
some information needed to run. It then goes out and get's a list
of all the x.BAT files in it's working directory. Q.BAT will never
be used as Q is the command to quit back to the BBS. If you have
enabled logging off via DoorKnob, then G.BAT will also NOT be used
as G will be the command to log off. If you disable logging off
via the door, then you can create and use a G.BAT file.
The menu files for DoorKnob must be named DOORKNOB.CLR and
DOORKNOB.BBS. The .CLR file is used when a caller has ANSI
enabled, the .BBS is used when ANSI is disabled. DoorKnob just
displays these files, so you are responsible for making sure that
they match what the .BAT files in the directory do. DoorKnob's
"Enter Command" prompt will show a list of the available commands
based on the .BAT files it finds.
There are sample menu files and batch files included in the
distribution ZIP file. This is basically the Main Menu extension
that is being run on my Paradigm BBS.
When a caller makes a selection, DoorKnob swaps most of it's code
out of memory and runs the batch file selected. At this point the
program run is in control, and DoorKnob no longer does anything
until that batch file finishes.
DoorKnob will log it's transactions to your caller's log for
informational purposes. If you would like more detailed
information about it's actions, use /DEBUG on the DoorKnob command
line. This will enable verbose logging.
When a user logs off via DoorKnob, it gives them a 10 second count
down where they have the option to hang up immediately or abort
back to DoorKnob.
There are several options available to the SysOp. DoorKnob will
take input from the local side so that if the user needs some help
you can do some typing for them.
Hitting the ESC key, will immediately abort the door and send the
user back to the BBS. You can press F1 and get a short help screen
of the keys available to the SysOp. Use caution here though, as
input from the user will not be processed while this screen is up
(their keystrokes will be processed as soon as you remove the help
screen). The help screen has a 10 second time out on it and will
remove its self after that timeout.
F6 will give the user an additional 5 minutes of time in the door.
F7 will take 5 minutes from the user. If there is less than 5
minutes left, time will be removed in 1 minute increments.
F9 will return the user to the BBS with a message saying that the
SysOp has requested them to return. F10 will return the user to
the BBS with NO message.
DoorKnob is active, it always keeps track of the user's time left
in the door. DoorKnob also has a 3 minute no keystroke timer. The
user will be issued messages at 2 min., 1 min. and 30 seconds and
then is logged off.
EPILOGUE:
This is a SHAREWARE utility. The program is NOT crippled and NO
features are disabled. Sending in the $1.00 US registration fee
with the registration form to the address below will get you a
registration number that will remove the [Unregistered Shareware
Version] message and allow your BBS name to be displayed.
Try the door thoroughly until you know in your heart that it is of
use to you, and then send in the registration form and fee. If it
isn't, please let me know what features might improve the door.
AUTHOR CONTACT:
Problems, solutions, kudos and ideas are welcomed. I can be
reached at the following:
The Paradigm BBS ßETATech Computer Consulting
404/671-1581 P. O. Box 566742
1200-19,200 Baud 24 Hrs/Day Atlanta, GA 31156-6013
DISCLAIMER:
Use of this program acknowledges this disclaimer of warranty: "This
program is supplied as is. ßETATech Computer Consulting disclaims
all warranties, express or implied, including, without limitation,
the warranties of merchantability and of fitness of this program
for any purpose. ßETATech Computer Consulting assumes no liability
for damages direct or consequential, which may result from the use
of this program."
REVISION HISTORY:
26-APR-1992 v1.0 Initial Release